doc: expand description of parseArg's default
#54431
Conversation
nodejs-github-bot
added
doc
|
From past experience, it is hard being clear about the config setup, the passed arguments, and the parsed result! I often say command-line but that does not cover custom arguments. The suggested text does not accurately cover I'll have a try, instead try changing the initial description: - The default option value when this argument is not passed.
+ The default option value when the option is not included in the arguments to parse. |
Co-authored-by: John Gee <john@ruru.gen.nz>
|
I always forget about |
doc/api/util.md
Outdated
| `type` property. When `multiple` is `true`, it must be an array. For | ||
| `string` arguments, if the option is passed it must still be followed by | ||
| a value. |
There was a problem hiding this comment.
| `type` property. When `multiple` is `true`, it must be an array. For | |
| `string` arguments, if the option is passed it must still be followed by | |
| a value. | |
| `type` property. When `multiple` is `true`, it must be an array. |
In my personal opinion, saying "The default option value when this argument is not passed." implies that if it passed, it must have a value.
Secondly, "it must still be followed by a value." makes it sound like the "default" option doesn't work on string arguments...
There was a problem hiding this comment.
makes it sound like the
"default"option doesn't work on string arguments.
The default option doesn't do anything when the option being specified is passed (except in strict: false), so that's a correct inference (as long as you don't skip over the "if the option is passed" part). Unless I'm misunderstanding you?
There was a problem hiding this comment.
I think "it must still be followed by a value" is redudant because of "The default option value when this argument is not passed.", but that might just be me.
RedYetiDev
added
the
commit-queue-squash
|
Another possible wording (which I used in a recent comment where I was trying to clarify behaviour): |
|
Tried a new wording based on @shadowspawn's suggestion, WDYT?
Hopefully that's sufficient to prevent people from coming to (incorrectly) believe that setting this would allow passing string-based options without arguments in |
|
Nice! Big +1 from me. |
|
Friendly ping. Not sure if there's a docs team I should @? |
Per #53427 (comment).